Child Protection - Tabular View

CP-ISLocalAuthorityAcknowledgementResponse Tabular View

REPC_RM000003GB01

FileResponse

This class is the response to the requested upload to CP-IS.

Used by:

[1..1] [M] creationTime (TS)

Model Attribute Description

The HL7 attribute creationTime is used to indicate when the local authority upload response was created.

Implementation in XML Instance

The XML attribute value of the XML element creationTime shall be populated with the time the local authority upload response was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

yyyy is the year
mm is the month
dd is the day
hh is the hour
mm is the minutes
ss is the seconds
[+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an incrementing sequence number to identify the local authority upload file that was originally sent to CP-IS.

Implementation in XML Instance

The XML element id shall carry the sequence number as follows:

The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.46"
The XML attribute extension shall contain the identifying sequence number.

When a file requested to be uploaded is rejected due to file level errors and the identifying sequence number cannot be determined by the CP-IS then:

The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.46"
The XML attribute extension shall contain the value -1

[1..1] [M] transmissionQuantity (INT)

Model Attribute Description

The HL7 attribute transmissionQuantity is used to carry the number of records processed and should match total number of records requested to be uploaded.

Implementation in XML Instance

The XML element transmissionQuantity should be populated as follows:

The XML attribute value shall contain an integer to indicate the total number of records.

When a file requested to be uploaded is rejected due to file level errors and the number of records cannot be determined, this will contain the value -1.

[1..1] [M] acknowledgementFile (AcknowledgementFile)

A link to the acknowledgement file.

[0..1] acknowledgementRecord (AcknowledgementRecord)

A link to the acknowledgement record

[1..1] [M] communicationFunctionRcv (CommunicationFunctionRcv)

A link to the communication function receive.

[1..1] [M] failedReturnedCP-ISRecords (FailedReturnedCP-ISRecords)

A link to the failed returned CP-IS records.

[0..*] message (Record)

A link to the record.

[1..1] [M] successfulReturnedCP-ISRecords (SuccessfulReturnedCP-ISRecords)

A link to the successful CP-IS records.

CommunicationFunctionRcv

This class is the receive function class used to link the recipients details to the batch.

Used by: FileResponse

[1..1] [M] typeCode (CS { CNE: CommunicationFunctionType } )
{ Fixed="RCV" }

Model Attribute Description

The HL7 attribute typeCode uses a code from the communicationFunctionType vocabulary to describe this class as a receive function.

Implementation in XML Instance

The XML attribute typeCode is fixed to "RCV".

Schema Constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] organisation (Organisation)

A link to the receiving organisation.

Organisation

This class details the organisation which sent the CP-IS upload.

Used by:

[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="ORG" }

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ORG".

Schema Constraint

The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

Schema Constraint

The attribute determinerCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the sending organisation. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
The XML attribute extension shall contain the ODS organisation code.

[1..1] [M] name (ON)

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance

The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.

[1..2] [M] telecom (SET<TEL>)

Model Attribute Description

The HL7 attribute telecom provides a contact telephone number for the organisation.

Implementation in XML Instance

This XML element telecom should be populated as below:

The XML attribute value of the XML element telecom should contain the telephone number.

For a telephone number the actual telephone number would be prefixed with tel:

The XML attribute use of the XML element telecom must be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for the contact details:

Code	Definition
EC	Emergency Contact - A contact used by clinicians in Out of Office hours (this is mandatory).
WP	Work place - A contact during business hours (this is optional, but if it is available it should be included).

AcknowledgementRecord

This class links to any validation reported at the record level.

Used by: FileResponse

[1..1] [M] typeCode (CS { CNE: CP-ISAcknowledgementType } )
{ Fixed="CPISAR" }

Model Attribute Description

The HL7 attribute typeCode uses a code from the CP-ISAcknowledgementType vocabulary to describe this class as a CP-IS record level acknowledgement.

Implementation in XML Instance

The XML attribute typeCode is fixed to "CPISAR".

Schema Constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..*] [M] acknowledgementRecordDetail (AcknowledgementRecordDetail)

A link to the acknowledgement record detail.

AcknowledgementRecordDetail

This class carries reported record level validation.

Used by: AcknowledgementRecord

[1..1] [M] code (CE { CNE:CP-ISUploadRecordResponse } )

Model Attribute Description

The HL7 attribute code uses a code from the CP-ISUploadRecordResponse vocabulary to indicate the response to the request to upload the child protection information record on to CP-IS.

When this code contains the value CPR07 the error will be further detailed using a qualifying code CP-ISUploadRecordResponseDetail vocabulary.

Implementation in XML Instance

The CE data type shall be used to carry this information in the XML element code as follows:

The XML attribute code should a value from the CP-ISUploadRecordResponse vocabulary
The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.473"
The XML attribute displayName shall contain the description associated with the code.

When this code contains the value CPR07 the xml element qualifier of the xml element translation will contain a second qualifying code as follows

The XML attribute code shall a value from the CP-ISUploadRecordResponseDetail vocabulary
The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.482"
The XML attribute displayName shall contain the description associated with the code.

[1..1] [M] location (ST)

Model Attribute Description

The HL7 attribute location is used to carry the xpath to the invalid or incorrect part of the record included within the message.

Implementation in XML Instance

The XML element location should be populated using the ST data type as follows:

The XML element location shall contain the xpath.

FailedReturnedCP-ISRecords

This class contains the number of invalid records which have been rejected and therefore are returned to the sender.

Used by: FileResponse

[1..1] [M] keyWordText (ST)
{ Fixed="FRCR" }

Model Attribute Description

The HL7 attribute keyWordText is used to hold a literal text string identifying the value contained in this class.

Implementation in XML Instance

The XML element keyWordText shall contain a fixed value of "FRCR".

Schema Constraint

The attribute keyWordText is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] value (INT)

Model Attribute Description

The HL7 attribute value is used to carry the number of invalid records that failed upload on CP-IS.

Implementation in XML Instance

The XML element value should be populated as follows:

The XML attribute value shall contain a integer to indicate the total number of failed records.

When a file requested to be uploaded is rejected due to file level errors and the number of records cannot be determined, this will contain the value -1.

AcknowledgementFile

This class links to any validation reported at the file level.

Used by: FileResponse

[1..1] [M] typeCode (CS { CNE: CP-ISAcknowledgementType } )
{ Fixed="CPISAF" }

Model Attribute Description

The HL7 attribute typeCode uses a code from the CP-ISAcknowledgementType vocabulary to describe this class as a CP-IS file level acknowledgement.

Implementation in XML Instance

The XML attribute typeCode is fixed to "CPISAF".

Schema Constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..*] [M] acknowledgementFileDetail (AcknowledgementFileDetail)

A link to the acknowledgement file detail.

AcknowledgementFileDetail

This class carries reported file level validation.

Important Note: Although multiple file level errors are supported by this message CP-IS will only ever return one file level error.

Used by: AcknowledgementFile

[1..1] [M] code (CV { CNE:CP-ISUploadFileResponse } )

Model Attribute Description

The HL7 attribute typeCode uses a code from the CP-ISUploadFileResponse vocabulary to indicate the response to the request to upload the child protection information file on to CP-IS.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

The XML attribute code shall a value from the CP-ISUploadFileResponse vocabulary
The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.474"
The XML attribute displayName shall contain the description associated with the code.

Schema Constraint

The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Record

The Record class is a dummy class used to connect the file class to the record.

Used by: FileResponse

[1..1] [M] cP-ISLAAcknowledgementResponse (CP-ISLAAcknowledgementResponse)

Link to the CP-IS LA Acknowledgement Response

CP-ISLAAcknowledgementResponse

This class represents the CP-IS local authority response message.

Used by:

[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }

Model Attribute Description

The HL7 attribute classCode describes this class as a control act.

Implementation in XML Instance

The XML attribute classCode is fixed to "CACT".

Schema Constraint

The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a control act event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

Schema Constraint

The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] code (CV { CNE:CP-ISMessageType } )
{ Fixed="02" }

Model Attribute Description

The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CPIS message.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

The XML attribute code shall contain a fixed value of "02"
The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.470"
The XML attribute displayName shall contain a fixed value of "CP-IS Local Authority Acknowledgement Response".

Schema Constraint

The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance.
The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance.
The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] pertinentInformation1

This class links the CP-IS LA Acknowledgement response class to the pertinent CP-IS Record.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="PERT" }

The HL7 attribute typeCode uses a code to describe this class as pertinent information.

Implementation in XML Instance

The XML attribute typeCode is fixed to "PERT".

Schema Constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] pertinentCP-ISRecord (CP-ISRecord)

Link to CP-IS Record

CP-ISRecord

A choice of valid or invalid child protection record information which was requested to be uploaded on to CP-IS.

The valid record indicates that the record with this NHS number has been successfully uploaded.

The invalid record is returned with the errors indicated with xpaths and error codes.

Used by: CP-ISLAAcknowledgementResponse

[1..1] either: ValidCP-ISRecord

The valid CP-IS record.

... or ... : InvalidCP-ISRecord

The invalid CP-IS record.

[1..2] [M] subject

A class which is a participation of record subject.

The subject is the child who is the subject of the child protection information.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="SBJ" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a subject participation.

Implementation in XML Instance

The XML attribute typeCode is fixed to "SBJ".

Schema constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] contentId (II) { "NPFIT-100035#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
The XML attribute extension shall contain one of the allowed template artefact identifiers.

[1..1] [M] participant (SubjectChoice)

A link to the choice of subject.

ValidCP-ISRecord

This class represents the valid CP-IS records.

The complete valid record is not returned only the subject's details. The presence of a valid record structure for the subject and a upload success code indicates that the record has been successfully uploaded on CP-IS.

Used by: CP-ISLAAcknowledgementResponse,CP-ISRecord

[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="INFO" }

Model Attribute Description

The HL7 attribute classCode describes this class as information.

Implementation in XML Instance

The XML attribute classCode is fixed to "INFO".

Schema Constraint

The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode describes this class as an information event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

Schema Constraint

The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] code (CV { CNE:CP-ISRecordType } )
{ Fixed="VR" }

Model Attribute Description

The HL7 attribute code uses a code from the CP-ISRecordType vocabulary to describe this control act as a CPIS valid record.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

The XML attribute code shall contain a fixed value of "VR"
The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.471"
The XML attribute displayName shall contain a fixed value of "Valid CP-IS Record".

Schema Constraint

The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance.
The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance.
The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.

InvalidCP-ISRecord

This class represents the invalid CP-IS records.

The complete invalid record is returned with the error(s) indicated with an xpath and error codes.

Used by: CP-ISLAAcknowledgementResponse,CP-ISRecord

[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="INFO" }

Model Attribute Description

The HL7 attribute classCode describes this class as information.

Implementation in XML Instance

The XML attribute classCode is fixed to "INFO".

Schema Constraint

The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode describes this class as an information event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

Schema Constraint

The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] code (CV { CNE:CP-ISRecordType } )
{ Fixed="IR" }

Model Attribute Description

The HL7 attribute code uses a code from the CP-ISRecordType vocabulary to describe this control act as a CPIS invalid record.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

The XML attribute code shall contain a fixed value of "IR"
The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.471"
The XML attribute displayName shall contain a fixed value of "Invalid CP-IS Record".

Schema Constraint

The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance.
The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance.
The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..3] [M] pertinentInformation

This class links the CP-IS Record class to the pertinent child protection plan type.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="PERT" }

The HL7 attribute typeCode uses a code to describe this class as pertinent information.

Implementation in XML Instance

The XML attribute typeCode is fixed to "PERT".

Schema Constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] contentId (II) { "NPFIT-100017#Act" }

Model Attribute Description

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
The XML attribute extension shall contain one of the allowed template artefact identifiers.

[1..1] [M] pertinentChildProtectionInformationChoice (ChildProtectionInformationChoice)

A link to the choice of child protection information.

ChildProtectionInformationChoice

A choice of child protection information.

Used by: InvalidCP-ISRecord

[1..1] : Template2

SubjectChoice

A choice of subjects.

Used by: CP-ISRecord

[1..1] : Template1

SuccessfulReturnedCP-ISRecords

The successful returned records.

Note: the whole record is not returned, only the part of the record which identifies the subject of the record.

Used by: FileResponse

[1..1] [M] keyWordText (ST)
{ Fixed="SCR" }

Model Attribute Description

The HL7 attribute keyWordText is used to hold a literal text string identifying the value contained in this class.

Implementation in XML Instance

The XML element keyWordText shall contain a fixed value of "SCR".

Schema Constraint

The attribute keyWordText is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] value (INT)

Model Attribute Description

The HL7 attribute value is used to carry the number of records that were successfully uploaded on to CP-IS

Implementation in XML Instance

The XML element value should be populated as follows:

The XML attribute value shall contain an integer to indicate the total number of successful records.

When a file requested to be uploaded is rejected due to file level errors, this will contain the value 0.

Child ProtectionDomain Message Specification

CP-ISLocalAuthorityAcknowledgementResponse Tabular View

Child Protection
Domain Message Specification